Skip to content

URL Submit API v1.0 (Free)

Social Animal's URL Submit API lets you submit URLs to process in Social Animal. You can submit 100 URLs in each call. After submission, these URLs are added to the article processing queue, which fetches the article pointed to by the URL, analyzes the content, gets share counts for the URL, etc. Please see example below for more information.

NOTE:

- This API free to use and is part of the Share Count API.
- The number of API request per month is the same as that of the monthly budget of Share Count API that your plan entitles you.

Things you need to know before you start

  • The quota for a non-batched mode API call is 1.
  • The quota for a batched mode API call depends size of the URLs array.
  • Rate limit is 1 req/sec by default, but customizable according to the subscription plan upto 5 req/sec. See the support section in this document for more details.

URL Submit API endpoint

POST /api/v1/articles/share_counts/urls

This API endpoint allows you to submit URLs for processing. This is mainly made available to get share counts for custom URLs that Social Animal may not be tracking in general. For example, URLs that many not be extensively shared on social media. Please refer to the query parameters below for further details.

You can batch URLs in a single request. You can specify up to 100 URLs in each request. Please see the section The Query below to see how you can send more than one URL.

Request Object Parameters

There is sufficient indication of whether parameters are mandatory, mutually exclusive, etc. Should you have any trouble using the Social Animal Content API, please see section below on support.

The Query

  • query (Object, required) -- Query by the specified key. Possible key are urls.

  • urls (Array, required) –- Multiple URLs can be sent as part of this array. A maximum of 100 URLs per request are allowed. If more than 100 URLs are passed, an error is returned. Even if you wish to specify only one URL, it has to be a single string element in the array. Do not send it as a stand-alone string.

Request Sample

{
    "query":{
      "urls": ["http://cricviz.com/2018/12/cricviz-analysis-bumrahs-perfect-over/",
      "https://www.digitalvidya.com/blog/seo-trends-2019/"
      ]
    }
}

Successful Response Sample

{
  message: 'Done!'
}

Support

Should you need any support regarding the Social Animal Content API subscription plans or developer support in general, please feel free to reach out to us at api@socialanimal.com.